This is the documentation for the Realbasic Plugins from Monkeybreadsoftware.de. You find these plugins and the newest version of this document at http://www.monkeybreadsoftware.de/realbasic inside the plugins section.
This help was last updated on Freitag, 6. September 2002 and covers 2136 items: 126 classes, 2 controls and 583 global functions.
| The list of the themes | Global methods by category | Global methods by name | The list of the classes | The list of the controls |
class HTMLViewer | |||||||||
| control, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
A small HTML rendering engine. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
BaseURL as string | |||||||||
| property, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> "". | |||||||
|
Function:
The current base URL. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
BestHeight as integer | |||||||||
| property, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> 0. | |||||||
|
Function:
Returns the best height of the window for that HTML file. | |||||||||
|
Example:
window.maxheight=BestHeight+16 // 16 for the scrollbar | |||||||||
|
Notes:
May return 0 if the best size is unknown. Requires HTMLRenderingLib on Mac OS 9. | |||||||||
BestWidth as integer | |||||||||
| property, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> 0. | |||||||
|
Function:
Returns the best width of the window for that HTML file. | |||||||||
|
Example:
window.maxwidth=BestWidth+16 // 16 for the scrollbar | |||||||||
|
Notes:
May return 0 if the best size is unknown. Requires HTMLRenderingLib on Mac OS 9. | |||||||||
CallURLtoFile as boolean | |||||||||
| property, HTMLViewer | Sa, 27. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> false. | |||||||
|
Function:
whether to call the URLtoFile event. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
CallWasURLVisited as boolean | |||||||||
| property, HTMLViewer | Sa, 27. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> false. | |||||||
|
Function:
whether to call the NewURL event. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
CallWasURLVisited as boolean | |||||||||
| property, HTMLViewer | Sa, 27. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> false. | |||||||
|
Function:
whether to call the WasURLVisited event. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
Close | |||||||||
| event, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
This event is fired before the control is destroyed. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
Drawborder as boolean | |||||||||
| property, HTMLViewer | Sa, 27. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | |||||||
|
Function:
whether to draw a black line around the control as a border. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
DrawInto(g as picture[, x as integer, y as integer, width as integer, height as integer]) | |||||||||
| method, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Does nothing. | Mac OS Carbon: Works. | Windows: Does nothing. | |||||||
|
Function:
Draws the content of the HTMLViewer into a picture. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
GotFocus | |||||||||
| event, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
This event is fired whenever the control get's activated. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
GoToAnchor(anchor as string) | |||||||||
| method, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Does nothing. | |||||||
|
Function:
Shows the given anchor within the current HTML file. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
GoToFile(file as folderitem,addtohistory as boolean) | |||||||||
| method, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Does nothing. | |||||||
|
Function:
Shows the given file. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
GoToString(htmldata as string,addtohistory as boolean) | |||||||||
| method, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Does nothing. | |||||||
|
Function:
Shows the the HTML file inside the htmldata parameter. | |||||||||
|
Notes:
Use this to display HTML pages which you made on runtime inside a string property. Requires HTMLRenderingLib on Mac OS 9. | |||||||||
GoToURL(url as string,addtohistory as boolean) | |||||||||
| method, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Does nothing. | |||||||
|
Function:
Shows the given URL. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
GrowboxCutOut as boolean | |||||||||
| property, HTMLViewer | Sa, 27. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | |||||||
|
Function:
whether to leave room for a growbox. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
HTMLFile as folderitem | |||||||||
| property, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> nil. | |||||||
|
Function:
The current HTML file. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
HTMLURL as string | |||||||||
| property, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> "". | |||||||
|
Function:
The current HTML URL. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
LostFocus | |||||||||
| event, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
This event is fired whenever the control get's deactivated. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
NewURL(url as string,targetframe as string,addhistory as boolean) | |||||||||
| Event, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
This event is fired whenever a new URL is displayed. | |||||||||
|
Notes:
You should update the title of the window, add the url to the history, update your back/forward/home buttons and your URL input field. Requires HTMLRenderingLib on Mac OS 9. Only called if the property CallNewURL is true. | |||||||||
Open | |||||||||
| event, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
This event is fired before the control is created so you can change the properties just before. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
Picture(width as integer,height as integer) as picture | |||||||||
| method, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Does nothing. | Mac OS Carbon: Works. | Windows: Does nothing. | |||||||
|
Function:
Creates a picture of the given size with the content of the HTMLViewer. | |||||||||
|
Notes:
I suggest to switch of scrollbars before calling this. Requires HTMLRenderingLib on Mac OS 9. | |||||||||
RootURL as string | |||||||||
| property, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> "". | |||||||
|
Function:
The current root URL. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
ScollbarH as integer | |||||||||
| property, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | |||||||
|
Function:
Show a horizontal scrollbar? | |||||||||
|
Notes:
Values:
| |||||||||
ScollbarV as integer | |||||||||
| property, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Works. | |||||||
|
Function:
Show a vertical scrollbar? | |||||||||
|
Notes:
Values:
| |||||||||
ScrollTo(x as integer,y as integer) | |||||||||
| method, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: Does nothing. | |||||||
|
Function:
Scrolls to the given position. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
Title as string | |||||||||
| property, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> "". | |||||||
|
Function:
The current title for this HTML page. | |||||||||
|
Example:
window.title=browser.title | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
URLtoFile(request as PageRequest) | |||||||||
| Event, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
This event is fired whenever a file is needed. | |||||||||
|
Notes:
pagerequest.URLSourceType will have one of this values: LookingForHTMLSource = 1 LookingForImage = 2 LookingForEmbedded = 3 LookingForImageMap = 4 LookingForFrame = 5 pagerequest.file will point to the file matching the URL if this exists. So if pagerequest.file=nil, you may show your errorpage. Also you may redirect using pagerequest.file to any other file to show. if pagerequest.file points to a picture of movie file you should show a generic html file using gotostring which includes this file, because a picture file itself will be showed in binary content. If pagerequest.displayfile is false the file in pagerequest.file is not showed. Set pagerequest.displayfile to false if you show another page. Requires HTMLRenderingLib on Mac OS 9. Only called if the property CallURLtoFile is true. | |||||||||
WasURLVisited(URL as string) as boolean | |||||||||
| Event, HTMLViewer | Sa, 27. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
This event is fired to ask you whether a link has allready be visited. | |||||||||
|
Notes:
Most times you just do this: return MyHistory.InHistory(url) Requires HTMLRenderingLib on Mac OS 9. Only called if the property CallWasURLVisited is true. | |||||||||
HTMLAvailable as boolean | |||||||||
| global method, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> false. | |||||||
|
Function:
Is the HTMLRenderingLib available? | |||||||||
|
Notes:
Should be impossible to get false here on Mac OS X. | |||||||||
HTMLUtilCreateFullURL(root as string,link as string) as string | |||||||||
| global method, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> "". | |||||||
|
Function:
Gives you a full URL out of a base and a link URL. | |||||||||
|
Notes:
Not very perfect. The one from HTMLSocket is better. Requires HTMLRenderingLib on Mac OS 9. | |||||||||
HTMLUtilFileFromURL(root as string,link as string) as folderitem | |||||||||
| global method, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> nil. | |||||||
|
Function:
Gives you a folderitem for the two URL components. | |||||||||
|
Notes:
Not very perfect. The one from HTMLSocket is better. Requires HTMLRenderingLib on Mac OS 9. | |||||||||
HTMLUtilURLFromFile(file as folderitem) as string | |||||||||
| global method, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> nil. | |||||||
|
Function:
Gives you an URL for a file. | |||||||||
|
Notes:
Requires HTMLRenderingLib on Mac OS 9. | |||||||||
HTMLVersion as integer | |||||||||
| global method, HTMLViewer | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> 0. | |||||||
|
Function:
The version of the HTMLRenderingLib. | |||||||||
Written 2002 by Christian Schmitz. Feel free to ask or report mistakes to realbasic@macsw.de.
Thanks.